Skip to content

fix: documentation typos#608

Merged
ezynda3 merged 1 commit intomark3labs:mainfrom
Artmorse:fix-typos
Oct 6, 2025
Merged

fix: documentation typos#608
ezynda3 merged 1 commit intomark3labs:mainfrom
Artmorse:fix-typos

Conversation

@Artmorse
Copy link
Contributor

@Artmorse Artmorse commented Oct 2, 2025 •
edited by coderabbitai bot
Loading

Description

This PR fixes some typos I found while reviewing the library documentation.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • MCP spec compatibility implementation
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code refactoring (no functional changes)
  • Performance improvement
  • Tests only (no functional changes)
  • Other (please describe):

Checklist

  • My code follows the code style of this project
  • I have performed a self-review of my own code
  • I have added tests that prove my fix is effective or that my feature works
  • I have updated the documentation accordingly

Summary by CodeRabbit

  • Refactor

    • Updated server API options: WithResourceCapabilities now requires two boolean parameters.
    • Renamed server transport option: WithStateless is now WithStateLess.
    • All server option usages updated to match new signatures/names.

  • Documentation

    • Updated server basics documentation to reflect the new option names and parameter requirements.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 2, 2025 •
edited
Loading

Walkthrough

Updates documentation in www/docs/pages/servers/basics.mdx to reflect server option API changes: WithResourceCapabilities now takes two booleans and usages updated; WithStateless is renamed to WithStateLess in HTTP transport examples.

Changes

Cohort / File(s) Summary of Changes
Docs: server options API updates
www/docs/pages/servers/basics.mdx		 Updated all server.NewMCPServer option examples: changed WithResourceCapabilities(...) to use two booleans (e.g., true, true). Renamed server.WithStateless(...) to server.WithStateLess(...) in HTTP transport block.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

  • Fix docs #430 — Introduces the same server option API changes (WithResourceCapabilities two booleans; WithStateless → WithStateLess), aligning code and docs.

Suggested reviewers

  • pottekkat
  • dugenkui03
  • rwjblue-glean

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title Check ⚠️ Warning The title “fix: documentation typos” only describes trivial spelling corrections, but this pull request updates code examples to reflect changes in the server API signature and renames a transport option, which is not captured by the title. The title therefore misrepresents the scope and main purpose of the changeset. Please update the title to clearly summarize the key documentation updates, for example “docs: update server option examples to new WithResourceCapabilities signature and rename stateless to stateLess,” so it accurately reflects the primary changes.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed The pull request description follows the repository’s template by including a concise Description section, selecting the appropriate Type of Change, and filling out the Checklist. The sections align with the required structure and provide the necessary information for reviewers.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Artmorse Artmorse changed the title Some typos fixed. fix: documentation typos Oct 2, 2025
coderabbitai[bot]
coderabbitai bot reviewed Oct 2, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 61b5d9e and 406afd7.

📒 Files selected for processing (1)
  • www/docs/pages/servers/basics.mdx (4 hunks)
🔇 Additional comments (1)
www/docs/pages/servers/basics.mdx (1)

39-69: No change needed for WithResourceCapabilities: the function is defined as func WithResourceCapabilities(subscribe, listChanged bool), so using two boolean arguments is correct.

@ezynda3 ezynda3 merged commit d2b01f6 into mark3labs:main Oct 6, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ezynda3 ezynda3 ezynda3 left review comments

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Artmorse @ezynda3